Interface Workspace

All Superinterfaces:
IPCObject
All Known Implementing Classes:
WorkspaceImpl

public interface Workspace extends IPCObject
Information provided by the PKI file:

    \class Workspace
    
    \brief Workspace is the base class for Logical and Physical workspace related objects.
    
    \example appWindow().getActiveWorkspace()
    
Author:
Auto-generated
  • Method Details

    • isLogicalView

      boolean isLogicalView()
      Information provided by the PKI file:
      
          \brief Returns true if the Logical workspace is currently visible, otherwise false.
          
          \return bool, true if the Logical workspace is currently visible, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isGeoView

      boolean isGeoView()
      Information provided by the PKI file:
      
          \brief Returns true if the Physical workspace is currently visible, otherwise false.
          
          \return bool, true if the Physical workspace is currently visible, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isRackView

      boolean isRackView()
      Information provided by the PKI file:
      
          \brief Returns true if the wiring closet is currently visible, otherwise false.
          
          \return bool, true if the wiring closet is currently visible, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getLogicalWorkspace

      LogicalWorkspace getLogicalWorkspace()
      Information provided by the PKI file:
      
          \brief Returns the Logical workspace.
          
          \return LogicalWorkspace, the Logical object.
          
              
      Returns:
      LogicalWorkspace Returns a LogicalWorkspace
    • getGeoView

      GeoView getGeoView()
      Information provided by the PKI file:
      
          \brief Returns the Physical workspace.
          
          \return GeoView, the GeoView object.
          
              
      Returns:
      GeoView Returns a GeoView
    • getRackView

      RackView getRackView()
      Information provided by the PKI file:
      
          \brief Returns the wiring closet.
          
          \return RackView, the RackView object.
          
              
      Returns:
      RackView Returns a RackView
    • getRootPhysicalObject

      PhysicalObject getRootPhysicalObject()
      Information provided by the PKI file:
      
          Returns the root/top item in the physical workspace location tree
          
              
      Returns:
      PhysicalObject Returns a PhysicalObject
    • getCurrentPhysicalObject

      PhysicalObject getCurrentPhysicalObject()
      Information provided by the PKI file:
      
          \brief Returns the current physical location.
          
          \return PhysicalObject, the PhysicalObject object.
          
              
      Returns:
      PhysicalObject Returns a PhysicalObject
    • setLogicalBackgroundPath

      void setLogicalBackgroundPath(String path, boolean tiled)
      Information provided by the PKI file:
      
          \brief Sets the background image of the logical workspace
          
          \param tiled, true if the image will be used as tiled layout and false if not
          
          \returns none
          
              
      Parameters:
      path - Takes in a parameter of path
      tiled - Takes in a parameter of tiled
    • devicesAt

      List<String> devicesAt(int x, int y, int w, int h, boolean includeClusters)
      Information provided by the PKI file:
      
          \brief Returns a list of devices within a rectangle with specified with and height right of the specified location
          
          \param x, x coordinate of the specified location
          
          \param y, y coordinate of the specified location
          
          \param w, width of the rectangle that contains the devices to be included
          
          \param h, height of the rectangle that contains the devices to be included
          
          \param includeClusters, true if including devices inside the cluster and false if not including
          
          \returns vector<QString> of device names
          
              
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      w - Takes in a parameter of w
      h - Takes in a parameter of h
      includeClusters - Takes in a parameter of includeClusters
      Returns:
      List<String> Returns a List<String>
    • setComponentOpacity

      void setComponentOpacity(String deviceName, String componentName, double value)
      Information provided by the PKI file:
      
          \brief Set the opacity for a component
          
          \param deviceName, device name
          
          \param componentName, component name
          
          \param value, the opacity value
          
          \returns none
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      componentName - Takes in a parameter of componentName
      value - Takes in a parameter of value
    • fillColor

      void fillColor(String deviceName, String componentName, int red, int green, int blue)
      Information provided by the PKI file:
      
          \brief Fill the component with a specified color
          
          \param deviceName, device name
          
          \param componentName, component name
          
          \param red, the rbg red value
          
          \param green, the rbg green value
          
          \param blue, the rbg blue value
          
          \returns none
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      componentName - Takes in a parameter of componentName
      red - Takes in a parameter of red
      green - Takes in a parameter of green
      blue - Takes in a parameter of blue
    • setComponentRotation

      void setComponentRotation(String deviceName, String componentName, double value)
      Information provided by the PKI file:
      
          \brief Set the rotation for a component
          
          \param deviceName, device name
          
          \param componentName, component name
          
          \param value, the rotation value
          
          \returns none
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      componentName - Takes in a parameter of componentName
      value - Takes in a parameter of value
    • setThingRotation

      void setThingRotation(String deviceName, double value)
      Information provided by the PKI file:
      
          \brief Set the rotation for a thing
          
          \param deviceName, device name
          
          \param value, the rotation value
          
          \returns none
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      value - Takes in a parameter of value
    • setThingCustomText

      void setThingCustomText(String deviceName, int x, int y, int width, int height, String text)
      Information provided by the PKI file:
      
          \brief Set the custom text for Thing at a location
          
          \param deviceName, device name
          
          \param x, the x coordinate of where the text will show up
          
          \param y, the y coordinate of where the text will show up
          
          \param width, the width the text
          
          \param height, the height of the text
          
          \param text, the string to show up
          
          \returns none
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      width - Takes in a parameter of width
      height - Takes in a parameter of height
      text - Takes in a parameter of text
    • hasProperty

      boolean hasProperty(String prop)
      Information provided by the PKI file:
      
          \brief Check if the a property is defined
          
          \param prop, property name
          
          \returns bool, true if it contains the property and false if not
          
              
      Parameters:
      prop - Takes in a parameter of prop
      Returns:
      boolean Returns a boolean
    • getProperty

      String getProperty(String prop)
      Information provided by the PKI file:
      
          \brief Return the property value
          
          \param prop, property name
          
          \returns QString, property value
          
              
      Parameters:
      prop - Takes in a parameter of prop
      Returns:
      String Returns a String
    • setProperty

      void setProperty(String prop, String value)
      Information provided by the PKI file:
      
          \brief Set the property value
          
          \param prop, property name
          
          \param value, property value
          
          \returns none
          
              
      Parameters:
      prop - Takes in a parameter of prop
      value - Takes in a parameter of value
    • getProperties

      List<String> getProperties()
      Information provided by the PKI file:
      
          \brief Return a list of properties defined
          
          \returns vector<QString>, list of property names
          
              
      Returns:
      List<String> Returns a List<String>
    • pauseEnvironmentTime

      void pauseEnvironmentTime()
      Information provided by the PKI file:
      
          \brief Pause the Environemnt time
          
          \returns none
          
              
    • resumeEnvironmentTime

      void resumeEnvironmentTime()
      Information provided by the PKI file:
      
          \brief Resume the Environemnt time
          
          \returns none
          
              
    • getEnvironmentTimeInSeconds

      int getEnvironmentTimeInSeconds()
      Information provided by the PKI file:
      
          \brief Get Environment time in seconds
          
          \returns int, time in seconds
          
              
      Returns:
      int Returns a int
    • resetEnvironment

      void resetEnvironment()
      Information provided by the PKI file:
      
          \brief Reset the Environemnt time
          
          \returns none
          
              
    • setParentGraphicFromComponent

      void setParentGraphicFromComponent(String deviceName, String componentName, int index, boolean bOnLogical, boolean bOnPhysical)
      Information provided by the PKI file:
      
          \brief Set parent graphic from component
          \param deviceName, device name
          \param componentName, component name
          \param index, the image index to be used
          \param bOnLogical, if true, set parent graphic in logical workspace
          \param bOnPhysical, if true, set parent graphic in physical workspace
          \returns none
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      componentName - Takes in a parameter of componentName
      index - Takes in a parameter of index
      bOnLogical - Takes in a parameter of bOnLogical
      bOnPhysical - Takes in a parameter of bOnPhysical
    • moveItemInWorkspace

      boolean moveItemInWorkspace(String itemName, int x, int y)
      Information provided by the PKI file:
      
          \brief Move item in workspace to a new location
          \param itemName, item name
          \param x, the x coordinate
          \param y, the y coordinate
          \returns none
          
              
      Parameters:
      itemName - Takes in a parameter of itemName
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      Returns:
      boolean Returns a boolean
    • setBaseZLevel

      void setBaseZLevel(String deviceName, float baseZLevel)
      Information provided by the PKI file:
      
          \brief Sets the base z level, which is the current z level plus the base level
          \param deviceName, item name
          \param baseZLevel, the base level
          \returns none
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      baseZLevel - Takes in a parameter of baseZLevel
    • getZLevel

      float getZLevel(String deviceName)
      Information provided by the PKI file:
      
          \brief Returns the current z level
          \returns none
          
              
      Parameters:
      deviceName - Takes in a parameter of deviceName
      Returns:
      float Returns a float
    • setVisible

      void setVisible()
    • zoomIn

      void zoomIn()
      Information provided by the PKI file:
      
          \brief Zooms into the workspace
          \returns none
          
              
    • zoomOut

      void zoomOut()
      Information provided by the PKI file:
      
          \brief Zooms out of the workspace
          \returns none
          
              
    • zoomReset

      void zoomReset()
      Information provided by the PKI file:
      
          \brief Resets the zoom scale of the workspace
          \returns none